Add custom headers support to RequestBuilder#96
Merged
neilberkman merged 1 commit intomainfrom Nov 4, 2025
Merged
Conversation
neilberkman
force-pushed
the
claude/fix-custom-headers-support-011CUoZu799DMdc5dorB3C7g
branch
from
e4df08d to
8e478f5
Compare
This adds support for passing custom headers through API calls, which is
required for certain DocuSign operations like working with locked envelopes.
The DocuSign API requires the X-DocuSign-Edit header with a lockToken when
performing PUT operations on locked envelopes, but there was no way to pass
this header through the generated API code.
Changes:
- Add special handling for :headers option in RequestBuilder.add_optional_params/3
- Headers option accepts a map of custom headers that get merged with defaults
- Add comprehensive unit tests for custom headers functionality
- Add integration tests using Bypass to verify headers are sent over HTTP
Usage example:
EnvelopeLocks.lock_put_envelope_lock(
conn,
account_id,
envelope_id,
body: lock_data,
headers: %{"X-DocuSign-Edit" => ~s({"LockToken": "...", "LockDurationInSeconds": "600"})}
)
Fixes #94
neilberkman
force-pushed
the
claude/fix-custom-headers-support-011CUoZu799DMdc5dorB3C7g
branch
from
8527a49 to
049b1ce
Compare
neilberkman
deleted the
claude/fix-custom-headers-support-011CUoZu799DMdc5dorB3C7g
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds support for passing custom headers through API calls, which is required for certain DocuSign operations like working with locked envelopes.
The DocuSign API requires the X-DocuSign-Edit header with a lockToken when performing PUT operations on locked envelopes, but there was no way to pass this header through the generated API code.
Changes:
Usage example:
EnvelopeLocks.lock_put_envelope_lock( conn, account_id, envelope_id, body: lock_data, headers: %{"X-DocuSign-Edit" => ~s({"LockToken": "...", "LockDurationInSeconds": "600"})} )
Fixes #94